Get Template By Document
AutomatR.DocuSign.Activities.GetTemplateByDocument
The "Get Template By Document" activity in AutomatR is part of the DocuSign Templates package, providing the capability to retrieve the template associated with a specific document within a DocuSign envelope. This activity facilitates seamless integration with DocuSign for template-related automation workflows.
Properties
| Name | Description |
|---|---|
| Input | |
| Envelope ID | Enter the Envelope ID to identify the DocuSign envelope containing the target document. This field supports only Strings or String variables. |
| Document ID | Enter the Document ID to identify the specific document within the DocuSign envelope. This field supports only Strings or String variables. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Get Template By Document" activity. This can be useful for handling synchronization issues. Integer variables containing the delay duration. Example: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variables containing the desired display name. |
| Output | |
| Response | Returns the template associated with the specified document in the form of a TemplateInformation object. Variables of data type TemplateInformation to store the template details. |
How to use:
- Drag and drop the "Get Template By Document" activity onto the workflow.
- Configure the properties by specifying the Envelope ID, Document ID, and optionally, the Delay.
- Execute the workflow to retrieve the template information associated with the specified document.
Important Note:
- Ensure that the "Get Template By Document" activity is used within the scope of the "DocuSign Scope" activity.
Example: Consider an example where the "Get Template By Document" activity is used to retrieve the template associated with a document in an envelope:
Get Template By Document:
Delay: 5
Envelope ID: "env123"
Document ID: "doc456"
Response: templateInfo
In this example, the activity waits for 5 seconds (as specified in the Delay property) and then retrieves information about the template associated with the document having ID "doc456" in the envelope with ID "env123." The details of the template are stored in the variable "templateInfo" for further processing in the workflow.